Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update structure of SUMMARY.md #418

Merged
merged 4 commits into from
Mar 4, 2025

Conversation

phklive
Copy link
Contributor

@phklive phklive commented Feb 28, 2025

Updated structure to make Miden book work

@phklive
Copy link
Contributor Author

phklive commented Mar 4, 2025

@greenhat @bitwalker could you guys see if this updated structure works for you.

@phklive phklive marked this pull request as ready for review March 4, 2025 10:53
@phklive
Copy link
Contributor Author

phklive commented Mar 4, 2025

The new structure requires that we have an index.md for each section see example here: https://github.com/0xPolygonMiden/miden-base/blob/main/docs/index.md

the ones we need to fill here are:

  • usage/index.md
  • appendix/index.md
  • guildes/index.md
  • design/index.md

Could you guys help me fill out these files, they are just an introduction to what the user will be able to find in this chapter.

@greenhat
Copy link
Contributor

greenhat commented Mar 4, 2025

I'm on it.

EDIT: #422

Copy link
Contributor

@greenhat greenhat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great! Thank you!

@greenhat
Copy link
Contributor

greenhat commented Mar 4, 2025

@phklive I'm going to merge this PR and fill the index.md #422 in a new PR ASAP.

@phklive
Copy link
Contributor Author

phklive commented Mar 4, 2025

Would it be possible to merge those into main please @greenhat?

Or would we need to wait for the next release?

I think that we should maybe re-open this PR with the base branch as main in that case.

@phklive phklive changed the base branch from next to main March 4, 2025 12:07
@phklive phklive changed the base branch from main to next March 4, 2025 12:08
@greenhat
Copy link
Contributor

greenhat commented Mar 4, 2025

@phklive we merged next to main 6 months ago, so it's very outdated. We're planning to make a release in the upcoming days and merge next to main.
Theoretically, we could merge to main only the docs folder, but since the docs describe the compiler version that in the next branch anyway, it does not make sense.

@phklive
Copy link
Contributor Author

phklive commented Mar 4, 2025

Okay great!

Could we make sure to merge this PR + the index PR + to make a release before the eow please guys @greenhat @bitwalker

@greenhat
Copy link
Contributor

greenhat commented Mar 4, 2025

That's our plan.

@greenhat greenhat merged commit ecba975 into 0xPolygonMiden:next Mar 4, 2025
6 checks passed
@phklive phklive deleted the phklive-add-mdbook branch March 4, 2025 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants